Alpha SDK and example for Node.js (Player tracking) #1658

steven-supersolid · 2020-06-28T16:55:30Z

What type of PR is this?
/kind feature

What this PR does / Why we need it:
Adds a Node.js alpha SDK that extends the base SDK with the alpha features of Player Tracking. Also adds an example server to showcase the SDK.
Once the features change stage then they can be moved to the main SDK with the tests and leave the framework for future alpha features.

Special notes for your reviewer:
Relates to #1033
Branched from #1657

steven-supersolid · 2020-06-28T16:56:41Z

/assign @markmandel

sdks/nodejs/spec/agonesSDK.spec.js

examples/nodejs-alpha/package.json

agones-bot · 2020-06-28T17:05:27Z

Build Failed 😱

Build Id: 81ebcefa-a4e7-4bf3-8f00-610f7f4261bd

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

sdks/nodejs/src/index.js

agones-bot · 2020-06-28T17:14:45Z

Build Failed 😱

Build Id: 8840c494-0742-4c9f-9daf-ab5c127648f5

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

examples/nodejs-alpha/Dockerfile

examples/nodejs-simple/Makefile

sdks/nodejs/src/index.js

# Conflicts: # examples/nodejs-simple/package-lock.json # examples/nodejs-simple/package.json

agones-bot · 2020-06-29T20:59:02Z

Build Failed 😱

Build Id: 61d95d49-1ec7-405e-9692-122f84525004

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2020-06-29T20:59:40Z

Build Failed 😱

Build Id: defb51e1-5003-4f33-9123-2db8d328b619

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2020-06-29T21:24:37Z

Build Succeeded 👏

Build Id: 3f59cdfa-a12f-4d54-9ca5-6bbc6fc67b15

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.7.0-c2acc0d
image: gcr.io/agones-images/agones-sdk:1.7.0-c2acc0d
image: gcr.io/agones-images/agones-ping:1.7.0-c2acc0d
Linux C++ SDK (build): agonessdk-1.7.0-c2acc0d-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.7.0-c2acc0d.zip

A preview of the website (the last 30 builds are retained):

https://c2acc0d-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1658/head:pr_1658 && git checkout pr_1658
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.7.0-c2acc0d

examples/nodejs-simple/README.md

sdks/nodejs/src/alphaAgonesSDK.js

sdks/nodejs/spec/alphaAgonesSDK.spec.js

examples/nodejs-simple/src/index.js

markmandel · 2020-07-14T20:27:06Z

Just touching base, to see if this work is still ongoing?

steven-supersolid · 2020-07-15T09:07:36Z

I can take another look this weekend and still mulling over what the canonical approach would be.
I think correctly we would distribute a separate npm module, e.g. 1.7.0-alpha and the new methods would be built in, however I also think that would be overkill here. The Go SDK approach is not so difficult to parse as to be avoided for JavaScript.

Why I chose this implementation is that there is an SDK class which has an interface of all available operations and once imported/required it is either a regular SDK or an alpha SDK. The alternative is that it is an SDK which has alpha property/method behind which the alpha features are located. I hadn't considered this and it is more of a composition pattern vs. my initial inheritance approach.

Random thoughts:

If we were to introduce beta features then with this approach alpha would have to extend beta which doesn't seem quite right
What if there is a change of interface in an alpha feature - should developers be able to call the original and the new method?
Should it be clear with each method call that this is an alpha method?
What if the alpha SDK requires some additional initialisation?

Perhaps overthinking but it would be useful to have a pattern to follow if we continue to roll out alpha and beta features.

markmandel · 2020-07-16T21:18:44Z

. The alternative is that it is an SDK which has alpha property/method behind which the alpha features are located. I hadn't considered this and it is more of a composition pattern vs. my initial inheritance approach.

This is how the Go SDK is working.

If we were to introduce beta features then with this approach alpha would have to extend beta which doesn't seem quite right

Beta would be it's own implementation. So no inheritance required.

What if there is a change of interface in an alpha feature - should developers be able to call the original and the new method?

Only the new. We can break Alpha (and beta) commands -- there is no guarantee of stability.

Should it be clear with each method call that this is an alpha method?

That was the idea behind SDK.Alpha().Command() to make that clear.

What if the alpha SDK requires some additional initialisation?

I can't this being a required at this stage, if so, we can handle that at that time.

Does that help?

agones-bot · 2020-07-18T12:16:08Z

Build Failed 😱

Build Id: 77e939d3-0f11-4441-ba3a-77cbee27c9d2

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2020-07-18T12:55:30Z

Build Failed 😱

Build Id: 2a24a2c2-1803-4ac6-8428-9f9af640a423

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2020-07-23T15:07:16Z

Build Succeeded 👏

Build Id: 34c97545-b001-4fe4-a586-cfaefed5a801

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.8.0-512b997
image: gcr.io/agones-images/agones-sdk:1.8.0-512b997
image: gcr.io/agones-images/agones-ping:1.8.0-512b997
Linux C++ SDK (build): agonessdk-1.8.0-512b997-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.8.0-512b997.zip

A preview of the website (the last 30 builds are retained):

https://512b997-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1658/head:pr_1658 && git checkout pr_1658
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.8.0-512b997

markmandel

This is looking great - just have a minor question and a couple of small nits (2019->2020), but otherwise, i think this is good to go 👍

sdks/nodejs/src/alpha.js

sdks/nodejs/src/agonesSDK.js

Co-authored-by: Mark Mandel <markmandel@google.com>

agones-bot · 2020-07-30T09:20:24Z

Build Succeeded 👏

Build Id: 0abc2e92-79b2-408e-ad30-f0dbd29f8f88

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.8.0-fbde7b1
image: gcr.io/agones-images/agones-sdk:1.8.0-fbde7b1
image: gcr.io/agones-images/agones-ping:1.8.0-fbde7b1
Linux C++ SDK (build): agonessdk-1.8.0-fbde7b1-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.8.0-fbde7b1.zip

A preview of the website (the last 30 builds are retained):

https://fbde7b1-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1658/head:pr_1658 && git checkout pr_1658
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.8.0-fbde7b1

agones-bot · 2020-08-03T08:58:37Z

Build Succeeded 👏

Build Id: 4d04f0e4-a159-448e-a811-85769d764420

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.8.0-55a3d23
image: gcr.io/agones-images/agones-sdk:1.8.0-55a3d23
image: gcr.io/agones-images/agones-ping:1.8.0-55a3d23
Linux C++ SDK (build): agonessdk-1.8.0-55a3d23-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.8.0-55a3d23.zip

A preview of the website (the last 30 builds are retained):

https://55a3d23-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1658/head:pr_1658 && git checkout pr_1658
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.8.0-55a3d23

markmandel · 2020-08-03T18:39:54Z

Just a reminder:
https://github.com/googleforgames/agones/pull/1658/files#diff-278846dade2570eb0da62e878bab72dfR1

Co-authored-by: Mark Mandel <markmandel@google.com>

steven-supersolid · 2020-08-04T10:44:55Z

Sorry I missed that one when I clicked the handy 'apply suggestion' button before!

agones-bot · 2020-08-04T11:04:51Z

Build Succeeded 👏

Build Id: f01274fb-9e47-4aee-9c8f-012940a3b311

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.8.0-8f0396e
image: gcr.io/agones-images/agones-sdk:1.8.0-8f0396e
image: gcr.io/agones-images/agones-ping:1.8.0-8f0396e
Linux C++ SDK (build): agonessdk-1.8.0-8f0396e-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.8.0-8f0396e.zip

A preview of the website (the last 30 builds are retained):

https://8f0396e-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1658/head:pr_1658 && git checkout pr_1658
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.8.0-8f0396e

markmandel

APPROVED 🔥

google-oss-robot · 2020-08-04T16:43:48Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: markmandel, steven-supersolid

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

) * update dependencies in sdk and example * update build and generate pb * add alpha sdk * export sdk and alpha sdk * cleanup nodejs-simple * add nodejs-alpha example Co-authored-by: Mark Mandel <markmandel@google.com>

steven-supersolid added 7 commits June 27, 2020 14:25

update dependencies in sdk and example

f030676

update build and generate pb

7afbf5f

add alpha sdk

bb54b99

cleanup

643cbc6

export sdk and alpha sdk

18777d4

cleanup nodejs-simple

42071f4

add nodejs-alpha example

f5694ae

google-oss-robot requested review from cyriltovena and EricFortin June 28, 2020 16:55

googlebot added the cla: yes label Jun 28, 2020

google-oss-robot added the size/XXL label Jun 28, 2020

google-oss-robot assigned markmandel Jun 28, 2020

steven-supersolid commented Jun 28, 2020

View reviewed changes

sdks/nodejs/spec/agonesSDK.spec.js Show resolved Hide resolved

steven-supersolid commented Jun 28, 2020

View reviewed changes

examples/nodejs-alpha/package.json Outdated Show resolved Hide resolved

nit: lint

662d10e

steven-supersolid commented Jun 28, 2020

View reviewed changes

sdks/nodejs/src/index.js Outdated Show resolved Hide resolved

markmandel reviewed Jun 29, 2020

View reviewed changes

examples/nodejs-alpha/Dockerfile Outdated Show resolved Hide resolved

examples/nodejs-simple/Makefile Show resolved Hide resolved

sdks/nodejs/src/index.js Outdated Show resolved Hide resolved

steven-supersolid added 3 commits June 29, 2020 21:34

Restore SDK export. Merge alpha example into simple example

e1aafce

Merge remote-tracking branch 'upstream/master' into player-tracking

86e87e0

# Conflicts: # examples/nodejs-simple/package-lock.json # examples/nodejs-simple/package.json

nit: readme version

c2acc0d

markmandel reviewed Jun 30, 2020

View reviewed changes

examples/nodejs-simple/README.md Show resolved Hide resolved

markmandel reviewed Jun 30, 2020

View reviewed changes

sdks/nodejs/src/alphaAgonesSDK.js Outdated Show resolved Hide resolved

markmandel reviewed Jun 30, 2020

View reviewed changes

sdks/nodejs/spec/alphaAgonesSDK.spec.js Outdated Show resolved Hide resolved

markmandel reviewed Jun 30, 2020

View reviewed changes

examples/nodejs-simple/src/index.js Outdated Show resolved Hide resolved

steven-supersolid added 3 commits July 18, 2020 12:53

Change alpha SDK from inheritance to composition

284883b

Update nodejs simple to be compatible with alpha sdk changes

d689fd9

Update deps and add test

5a590d5

Merge branch 'master' into player-tracking

e990dc6

Merge branch 'master' into player-tracking

512b997

markmandel reviewed Jul 29, 2020

View reviewed changes

sdks/nodejs/src/alpha.js Outdated Show resolved Hide resolved

sdks/nodejs/src/agonesSDK.js Show resolved Hide resolved

Update sdks/nodejs/src/alpha.js

fbde7b1

Co-authored-by: Mark Mandel <markmandel@google.com>

Merge branch 'master' into player-tracking

55a3d23

Update sdks/nodejs/spec/alphaAgonesSDK.spec.js

8f0396e

Co-authored-by: Mark Mandel <markmandel@google.com>

markmandel approved these changes Aug 4, 2020

View reviewed changes

google-oss-robot added the lgtm label Aug 4, 2020

google-oss-robot added the approved label Aug 4, 2020

markmandel merged commit 4225416 into googleforgames:master Aug 4, 2020

markmandel added this to the 1.8.0 milestone Aug 4, 2020

markmandel added area/examples Examples. Usually found in the `examples` directory kind/feature New features for Agones labels Aug 11, 2020

steven-supersolid deleted the player-tracking branch October 25, 2020 18:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Alpha SDK and example for Node.js (Player tracking) #1658

Alpha SDK and example for Node.js (Player tracking) #1658

steven-supersolid commented Jun 28, 2020 •

edited

Loading

steven-supersolid commented Jun 28, 2020

agones-bot commented Jun 28, 2020

agones-bot commented Jun 28, 2020

agones-bot commented Jun 29, 2020

agones-bot commented Jun 29, 2020

agones-bot commented Jun 29, 2020

markmandel commented Jul 14, 2020

steven-supersolid commented Jul 15, 2020

markmandel commented Jul 16, 2020

agones-bot commented Jul 18, 2020

agones-bot commented Jul 18, 2020

agones-bot commented Jul 23, 2020

markmandel left a comment

agones-bot commented Jul 30, 2020

agones-bot commented Aug 3, 2020

markmandel commented Aug 3, 2020

steven-supersolid commented Aug 4, 2020

agones-bot commented Aug 4, 2020

markmandel left a comment

google-oss-robot commented Aug 4, 2020

Alpha SDK and example for Node.js (Player tracking) #1658

Alpha SDK and example for Node.js (Player tracking) #1658

Conversation

steven-supersolid commented Jun 28, 2020 • edited Loading

steven-supersolid commented Jun 28, 2020

agones-bot commented Jun 28, 2020

agones-bot commented Jun 28, 2020

agones-bot commented Jun 29, 2020

agones-bot commented Jun 29, 2020

agones-bot commented Jun 29, 2020

markmandel commented Jul 14, 2020

steven-supersolid commented Jul 15, 2020

markmandel commented Jul 16, 2020

agones-bot commented Jul 18, 2020

agones-bot commented Jul 18, 2020

agones-bot commented Jul 23, 2020

markmandel left a comment

Choose a reason for hiding this comment

agones-bot commented Jul 30, 2020

agones-bot commented Aug 3, 2020

markmandel commented Aug 3, 2020

steven-supersolid commented Aug 4, 2020

agones-bot commented Aug 4, 2020

markmandel left a comment

Choose a reason for hiding this comment

google-oss-robot commented Aug 4, 2020

steven-supersolid commented Jun 28, 2020 •

edited

Loading